今回はJavaFXでUIコントロールの選択・フォーカス箇所を取得・設定する方法について確認する。選択やフォーカスの操作については別記事（その1・その2・その3）でも紹介してきたが、本記事では総括的な視点で見ていく。

---

■　選択操作

　ラジオボタンなどでユーザが選択した項目を取得したり、逆にプログラム上で選択項目を選択する方法について確認する。項目選択に関係してプログラム上で行える操作・設定は以下の3つである。

1. ユーザが選択した項目およびそのインデックスを取得
2. プログラムで項目を選択
3. 選択・選択解除イベント発生時の処理（イベントリスナー）を設定

　上記の１～３の操作・設定は、選択操作クラスで行う。選択操作クラスは選択項目クラスのgetToggleGroup関数やgetSelectionModel関数で取得できる。選択項目クラスに対応する選択操作クラスと、その操作用の関数を表1に示す。

表１：選択項目クラスと対応する選択操作クラス、選択取得関数・選択設定関数・バインディングの取得関数の早見表

クラス名	選択操作クラス	選択取得	選択設定	イベントリスナー用の バインディング取得
RadioButton	ToggleGroup	getSelectedTogle()	selectToggle()	selectedToggleProperty()
ChoiceBox	SingleSelectionModel<T>	getSelectedIndex() getSelectedItem() isEmpty() isSelected()	select() selectFirst() selectLast() selectNext() selectPrevious() clearAndSelect() clearSelection() setSelectedIndex() setSelectedItem()	selectedIndexProperty() selectedItemProperty()
ComboBox
ListView	MultipleSelectionModel (*単複選択可能)	getSelectedIndices() getSelectedItems()	selectFirst() selectLast() selectRange() selectIndices() selectAll()	getSelectedIndices() getSelectedItems()
TreeView
TableView	TableView. TableViewSelectionModel (*単複選択可能) (*行選択可能)	isEmpty() isSelected() getSelectedCells() getSelectedIndices() getSelectedItems()	select() selectFirst() selectLast() selectNext() selectPrevious() selectRange() selectIndices() selectAll() clearAndSelect() clearSelection()	getSelectedCells() getSelectedIndices() getSelectedItems()
TreeTableView	TreeTableView. TreeTableViewSelectionModel (*単複選択可能) (*行選択可能)

*単複選択可能…SelectionModel関数で単体選択(SelectionMode.SINGLE)か、複数選択(SelectionMode.MULTUPLE)かを選べる

---

■　フォーカス操作

　画面表示可能なクラスは、すべてフォーカス設定用のrequestFocus関数を持っている。以下では、ListViewなどクラス内に更に選択項目があるクラスについて、クラス内部のフォーカスを操作する方法を確認する。プログラム上で行えるフォーカスの操作は、以下の3つの操作・設定である。

1. フォーカスがあたっている項目を取得
2. 項目にフォーカスを設定
3. フォーカス・イベント発生時の処理（イベントリスナー）を設定

　上記の１～３の操作・設定は、フォーカス操作クラスで行う。フォーカス操作クラスは該当クラスのgetFocusModel関数で取得できる。また、フォーカス・イベント処理用のイベントリスナー登録については、表2のイベントハンドラ用のバインディング取得関数でバインディングを取得後、バインディング変数のaddListener関数でイベントリスナーを設定する形となる。

表2：フォーカス位置取得可能なクラスに対応するフォーカス操作用クラス、位置取得／設定関数・バインディングの取得関数の早見表

クラス名	フォーカス操作用クラス	フォーカス 位置取得	フォーカス設定	イベントリスナー用の バインディング取得
ListView	FocusModel	isFocused() getFocusedIndex() getFocusedItem() focusedIndexProperty() focusedItemProperty()	focus() focusNext() focusPrevious() requestFocus()	focusedIndexProperty() focusedItemProperty()
TreeView
TableView	TableView. TableViewFocusModel	isFocused() getFocusedCell() focusedCellProperty()	focus() focusAboveCell() focusBelowCell() focusLeftCell() focusRightCell() focusNext() focusPrevious() requestFocus()	focusedCellProperty()
TreeTableView	TreeTableView. TreeTableViewFocusModel

　また、フォーカスの遷移順の指定は自動的に決定されるが、遷移順を変更したい場合にはTraversalEngineを利用するという方法があるらしい(*4)。ただし、この方法は公式な方法ではないため、将来のアップデートで動作しなくなる可能性があることを考慮してほしいとのこと。

■　サンプルプログラム

　フォーカス操作の動作確認を行うサンプルプログラムを以下に示す。サンプルではボタン押下によりフォーカスが移動し、標準出力にフォーカス位置の情報が出力される。

◇サンプルコード

package application;

import javafx.application.Application;
import javafx.collections.FXCollections;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.ListView;
import javafx.scene.control.TextField;
import javafx.scene.layout.VBox;
import javafx.stage.Stage;

public class TestFocus extends Application
{

    public static void main(String[] args) {
        launch(args);
    }
    
    @Override
    public void start(Stage primaryStage)
    {
        // フォント色がおかしくなることへの対処
        System.setProperty( "prism.lcdtext" , "false" );
        
        // シーングラフの作成
        VBox                root        = new VBox();
        TextField           textField1  = new TextField(); 
        TextField           textField2  = new TextField();
        ListView<String>    listView1   = new ListView<String>();
        Button              button      = new Button( "change focus!" );
        root.getChildren().addAll( textField1 , textField2 , listView1 , button );
        
        // シーンの作成
        Scene   scene       = new Scene( root , 250 , 200 );
        
        // ウィンドウ表示
        primaryStage.setScene( scene );
        primaryStage.show();
        
        // 初期設定
        textField1.setPromptText( "input text1" );
        textField2.setPromptText( "input text2" );
        textField2.requestFocus();                  // 初期フォーカスの設定
        listView1.setItems( FXCollections.observableArrayList( "1st" , "2nd" , "3rd" ) );
        
        // ボタン押下時のイベントリスナー登録
        EventHandler<ActionEvent> buttonActionFilter =
                ( event ) -> {  
                                // リスト・ビューにフォーカスをあて、
                                // リスト・ビュー内部のフォーカス位置を変更
                                listView1.requestFocus();
                                listView1.getFocusModel().focusNext();
                                event.consume();
                             };
        button.addEventHandler( ActionEvent.ACTION , buttonActionFilter );
        
        // リスト・ビューにフォーカス変更検出時の
        // イベントリスナーを登録
        listView1.getFocusModel().focusedIndexProperty().addListener(
                    ( ov , old , current ) ->
                        { 
                            // リスト・ビュー内のフォーカス位置を出力
                            System.out.println( "Focus in the listView is : " + listView1.getFocusModel().getFocusedIndex() );
                        }
                );
        
    }
}

◇実行結果

「change focus!」ボタンを5回押した場合の標準出力

Focus in the listView is : 0
Focus in the listView is : 1
Focus in the listView is : 2

◇解説
　フォーカス位置の設定は、ボタン押下時に起動するイベントハンドラ内で行っている(49行目～56行目)。ListView::requestFocus関数でリスト・ビュー自身にフォーカスを移動させ、FocusModel::getFocusNext関数でリスト内の次の項目へフォーカスを移動させている(53行目,54行目)。

　リストビュー内のフォーカス移動検知は、バインディングへのイベントリスナー登録で行っている(61行目～67行目)。イベントリスナー内では、フォーカスを持つ項目のインデックス番号を出力している(65行目)。ボタンを5回押下しても標準出力が3行しか出力されないのは、4回目以降のボタン押下でフォーカス位置が変更しないためである。

---

■　参照

1. JavaDoc - クラスSelectionModel
2. JavaDoc - クラスMultipleSelectionModel
3. JavaDoc - クラスFocusModel
4. Stack Over Flow「JavaFX: How to change the focus traversal policy?」
5. Stack Over Flow「Equivalent of AWT/Swing transferFocus in JavaFX」